/*
 *  Copyright 2009 David Kuhn <david.s.kuhn at gmail.com>.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */
package com.google.code.teamtools.domain;

/**
 * Interface for a role. <code>IPerson</code> must have one or more roles.
 * 
 * @author David Kuhn
 */
public interface IRole extends IEntity
{	
	/**
	 * Returns the abbreviated name for the role.
	 * 
	 * @return the role's abbreviated name
	 */
	String getAbbreviation();
	
	/**
	 * Returns the role group that this role belongs to.
	 * 
	 * @return the role's group
	 */
	IRoleGroup getRoleGroup();
	
    /**
     * Returns the title of the role.
     * 
     * @return the role title
     */
    String getTitle();
    
    /**
     * Sets the abbreviated name for the role.
     * 
     * @param abbreviation the abbreviation to set
     */
    void setAbbreviation(String abbreviation);
    
    /**
     * Sets the role group that this role belongs to.
     * 
     * @param group the role group to set
     */
    void setRoleGroup(IRoleGroup group);
    
    /**
     * Sets the title of the role.
     * 
     * @param title the role title to set
     */
    void setTitle(String title);
}
